openapi: 3.0.3
info:
  title: '@pocket Web API リファレンス'
  version: '1.0'
  description: |+
    # 共通仕様

    ### 仕様

    <table>
      <tr>
        <th>プロトコル</th>
        <td>HTTPS</td>
      </tr>
      <tr>
        <th>フォーマット</th>
        <td>JSON</td>
      </tr>
      <tr>
        <th>文字コード</th>
        <td>UTF-8</td>
      </tr>
      <tr>
        <th>エスケープ文字</th>
        <td>「\」 (バックスラッシュ)</td>
      </tr>
    </table>

    ### URL
    ご契約サイトURL + 各APIでリクエストに必要なURL

    ### Web APIの利用について
    Web APIを利用して情報にアクセスするためには、認証キーが必要になります。
    1. 認証キーは下記のメニューで作成できます。  
       * アプリAPI：アプリ設定 > 設定 > 認証設定(サービス連携)  
       * ユーザ/通知API：管理者設定 > 認証設定(サービス連携)  
    2. リクエストヘッダにX-At-Pocket-API-Keyを追加し、作成した認証キーをセットします。


    ### リクエストヘッダ
    <table>
      <tr>
        <th>ヘッダ名</th>
        <th>必須</th>
        <th>内容</th>
      </tr>
      <tr>
        <td>X-At-Pocket-API-Key</td>
        <td>○</td>
        <td>認証設定で作成したキーを指定します</td>
      </tr>
      <tr>
        <td>X-HTTP-Method-Override</td>
        <td></td>
        <td>X-HTTP-Method-OverrideにHTTPメソッドを指定してリクエストを行った場合、指定したHTTPメソッドに対応するAPIが実行されます。
          <ul>
            <li>このヘッダはPOSTリクエストの場合にのみ有効です。</li>
            <li>指定できるHTTPメソッドはGET、POST、PUT、DELETEのみです。</li>
          </ul>
        </td>
      </tr>
    </table>

    ### レスポンス
    HTTPステータスが200系の場合、正常終了になります。それ以外はエラーとなります。

    エラーの場合はレスポンスボディに以下の内容を含むerrorsが含まれます。
    <table>
      <tr>
        <th>パラメータ名</th>
        <th>値の型</th>
        <th>説明</th>
      </tr>
      <tr>
        <td>code</td>
        <td>数字</td>
        <td>エラーコードが記載されます。</td>
      </tr>
      <tr>
        <td>message</td>
        <td>文字列</td>
        <td>エラーメッセージの概要が記載されます。</td>
      </tr>
      <tr>
        <td>details</td>
        <td>配列</td>
        <td>詳細なエラーメッセージがある場合、エラーメッセージが記載されます。</td>
      </tr>
    </table>

    ```json
    {
        "errors": {
            "code": 400,
            "message": "Bad Request",
            "details": [
                {
                    "message": "アプリIDは半角数字で入力してください。"
                }
            ]
        }
    }
    ```

    ### エラーメッセージ
    リクエストでエラーが発生した場合、2つのエラー情報を返却します。
    * HTTPステータスコード
    * 応答本文内のJSONメッセージ

    エラーメッセージはアプリ管理メニュー内の「サービス連携 > 監査ログ」からも確認できます。

    #### エラー内容と対応方法
    <table class="api-params">
      <tbody>
        <tr>
          <th>コード</th>
          <th>メッセージ</th>
          <th>エラー内容と対応方法</th>
        </tr>
        <tr>
          <td>400</td>
          <td>Bad Request</td>
          <td>必須フィールドまたは必須パラメータが提供されていない。提供された値が無効の場合、または提供されたフィールドの組み合わせが無効であることを意味します。<br> エラーの詳細内容がerrorsフィールドに記載されて返却されるので、内容を確認して適切な対応を行ってください。</td>
        </tr>
        <tr>
          <td>401</td>
          <td>Unauthorized</td>
          <td>認証が無効なことを意味します。<br> 使用している認証用文字列が無効なため、正しい値を指定してください。</td>
        </tr>
        <tr>
          <td>402</td>
          <td>Request exhausted per month</td>
          <td>月当たりのAPIの利用制限数に達したことを意味します。<br> 制限が解除されるまで対象のAPIはご利用頂けません。</td>
        </tr>
        <tr>
          <td>402</td>
          <td>Request exhausted per 100 second</td>
          <td>100秒当たりのAPIの利用制限数に達したことを意味します。<br> 制限が解除されるまで対象のAPIはご利用頂けません。</td>
        </tr>
        <tr>
          <td>403</td>
          <td>Access Denied</td>
          <td>リクエストしたAPIの利用権限が無いことを意味します。<br> 利用権限が付与されているか確認を行ってください。</td>
        </tr>
        <tr>
          <td>404</td>
          <td>Not Found</td>
          <td>指定されたリソースが見つからなかったことを意味します。</td>
        </tr>
        <tr>
          <td>405</td>
          <td>Method Not Allowed</td>
          <td>不正なHTTPメソッドでリクエストされた事を意味します。<br> 有効なHTTPメソッドはGET、POST、PUT、DELETEのみです。</td>
        </tr>
        <tr>
          <td>500</td>
          <td>Internal Server Error</td>
          <td>リクエストの処理中に予期しないエラーが発生しました。<br> サーバ側の障害の可能性がある為、時間をおいて再度実行してください。</td>
        </tr>
      </tbody>
    </table>

    ### 制限事項
      @pocket Web APIの利用には以下の制限があります。制限は今後変更される可能性があります。

      - リクエスト件数はAPI単位でカウントを行い、月単位でリセットされます。   
        ※ 利用制限数は 月30,000件 までとなります。ただし、通知APIに限り 月100,000件 まで利用可能です。
      - リクエストのカウントはサイト単位で行います。複数ユーザでリクエストを行った場合、各リクエストが1回としてカウントされます。
      - 100秒当たりの利用制限数は100回までとなります。  
      - 一度に取得できる最大件数は1,000件までです。
      - 一度に登録できる最大件数は1,000件までです。
      - 存在しないフィールドをリクエストに含めた場合、その値は無視されます。
      
    ### ファイルデータの扱い
      ファイルデータの登録・更新は下記のような形式で行います。
    <table>
      <tr>
        <th>パラメータ名</th>
        <th>値の型</th>
        <th>必須</th>
        <th>説明</th>
      </tr>
      <tr>
        <td>name</td>
        <td>文字列</td>
        <td>○</td>
        <td>ファイル名</td>
      </tr>
      <tr>
        <td>type</td>
        <td>文字列</td>
        <td>○</td>
        <td>ファイルタイプ</td>
      </tr>
      <tr>
        <td>content</td>
        <td>文字列</td>
        <td>○</td>
        <td>base64エンコードしたファイルデータ</td>
      </tr>
    </table>

    ```json
    {
        "field-1": [
          {
            "name": "Sample.png",
            "type": "image/png",
            "content": "..." 
          },
          {
            "name": "Sample2.png",
            ...
          }
        ]
    }
    ```

tags:
  - name: Organizations
    x-displayName: 組織API
    description: 組織のAPI
  - name: Positions
    x-displayName: 役職API
    description: 役職のAPI
  - name: Users
    x-displayName: 利用者API
    description: 利用者のAPI
  - name: Forms
    x-displayName: フォームAPI
    description: フォームのAPI
  - name: Fields
    x-displayName: フィールドAPI
    description: フィールドのAPI
  - name: Records
    x-displayName: レコードAPI
  - name: Notices
    x-displayName: 通知API
paths:
  /api/admin/organizations:
    get:
      summary: 組織一覧取得
      description: 登録されている組織を取得します。
      tags:
        - Organizations
      operationId: OrganizationService/export
      parameters:
        - in: query
          name: name
          description: 組織名
          required: false
          schema:
            title: 組織名
            type: string
        - $ref: '#/components/parameters/page'
        - $ref: '#/components/parameters/limit'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  organizations:
                    title: 組織データリスト
                    type: array
                    items:
                      $ref: '#/components/schemas/organizations'
    post:
      summary: 組織登録
      description: 組織を登録します。
      tags:
        - Organizations
      operationId: OrganizationService/post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/organizations'
      responses:
        '201':
          description: Created
  /api/admin/organizations/{code}:
    get:
      summary: 組織情報取得
      description: 組織管理コードから組織を取得します。
      tags:
        - Organizations
      operationId: OrganizationService/get
      parameters:
        - in: path
          name: code
          required: true
          description: 組織管理コード
          schema:
            title: 組織管理コード
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/organizations'
    put:
      summary: 組織更新
      description: 組織を更新します。
      tags:
        - Organizations
      operationId: OrganizationService/update
      parameters:
        - in: path
          name: code
          required: true
          style: simple
          explode: false
          schema:
            title: 組織管理コード
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/organizations'
        required: false
      responses:
        '204':
          description: NO CONTENT
    delete:
      summary: 組織削除
      description: 組織管理コードを指定して組織を削除します。
      tags:
        - Organizations
      operationId: OrganizationService/delete
      parameters:
        - in: path
          name: code
          required: true
          style: simple
          explode: false
          schema:
            title: 組織管理コード
            type: string
      responses:
        '204':
          description: NO CONTENT
  /api/admin/organizations/import:
    post:
      summary: 組織インポート
      description: 組織をインポートします。
      tags:
        - Organizations
      operationId: OrganizationService/import
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                organizations:
                  title: 組織データ
                  type: array
                  maxItems: 100
                  items:
                    $ref: '#/components/schemas/organizations'
      responses:
        '204':
          description: NO CONTENT
  /api/admin/positions:
    get:
      summary: 役職一覧取得
      description: 登録されている役職を取得します。
      tags:
        - Positions
      operationId: PositionService/export
      parameters:
        - in: query
          name: name
          description: 役職名
          required: false
          schema:
            title: 役職名
            type: string
        - $ref: '#/components/parameters/page'
        - $ref: '#/components/parameters/limit'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  positions:
                    title: 役職データリスト
                    type: array
                    items:
                      $ref: '#/components/schemas/positions'
    post:
      summary: 役職登録
      description: 役職を登録します。
      tags:
        - Positions
      operationId: PositionService/post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/positions'
      responses:
        '201':
          description: Created
  /api/admin/positions/{code}:
    get:
      summary: 役職情報取得
      description: 役職管理コードから役職を取得します。
      tags:
        - Positions
      operationId: PositionService/get
      parameters:
        - in: path
          name: code
          required: true
          description: 役職管理コード
          schema:
            title: 役職管理コード
            type: string
            maxLength: 256
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/positions'
    put:
      summary: 役職更新
      description: 役職を更新します。
      tags:
        - Positions
      operationId: PositionService/update
      parameters:
        - in: path
          name: code
          required: true
          style: simple
          explode: false
          schema:
            title: 役職管理コード
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/positions'
        required: true
      responses:
        '204':
          description: NO CONTENT
    delete:
      summary: 役職削除
      description: 役職管理コードを指定して役職を削除します。
      tags:
        - Positions
      operationId: PositionService/delete
      parameters:
        - in: path
          name: code
          required: true
          style: simple
          explode: false
          schema:
            title: 役職管理コード
            type: string
      responses:
        '204':
          description: NO CONTENT
  /api/admin/positions/import:
    post:
      summary: 役職インポート
      description: 役職をインポートします。
      tags:
        - Positions
      operationId: PositionService/import
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                positions:
                  title: 組織データ
                  type: array
                  maxItems: 100
                  items:
                    $ref: '#/components/schemas/positions'
      responses:
        '204':
          description: NO CONTENT
  /api/admin/users:
    get:
      summary: ユーザ一覧取得
      description: 登録されているユーザを取得します。
      tags:
        - Users
      operationId: UserService/export
      parameters:
        - in: query
          name: name
          description: ユーザ名
          required: false
          schema:
            title: ユーザ名
            type: string
        - $ref: '#/components/parameters/page'
        - $ref: '#/components/parameters/limit'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  user:
                    title: ユーザデータリスト
                    type: array
                    items:
                      $ref: '#/components/schemas/allUser'
    post:
      summary: ユーザ登録
      description: ユーザを登録します。
      tags:
        - Users
      operationId: UserService/post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/insertUser'
      responses:
        '201':
          description: Created
  /api/admin/users/{code}:
    get:
      summary: ユーザ情報取得
      description: ユーザ管理コードからユーザを取得します。
      tags:
        - Users
      operationId: UserService/get
      parameters:
        - in: path
          name: code
          required: true
          description: ユーザ管理コード
          schema:
            title: ユーザ管理コード
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/allUser'
    put:
      summary: ユーザ更新
      description: ユーザを更新します。
      tags:
        - Users
      operationId: UserService/update
      parameters:
        - in: path
          name: code
          required: true
          style: simple
          explode: false
          schema:
            title: ユーザ管理コード
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/allUser'
      responses:
        '204':
          description: NO CONTENT
    delete:
      summary: ユーザ削除
      description: ユーザ管理コードを指定してユーザを削除します。
      tags:
        - Users
      operationId: UserService/delete
      parameters:
        - in: path
          name: code
          required: true
          style: simple
          explode: false
          schema:
            title: ユーザ管理コード
            type: string
      responses:
        '204':
          description: NO CONTENT
  /api/admin/users/import:
    post:
      summary: ユーザインポート
      description: ユーザをインポートします。
      tags:
        - Users
      operationId: UserService/import
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                user:
                  title: ユーザデータ
                  type: array
                  maxItems: 100
                  items:
                    $ref: '#/components/schemas/allUser'
      responses:
        '204':
          description: NO CONTENT
  /api/apps/forms:
    get:
      summary: フォーム一覧取得
      tags:
        - Forms
      description: 登録されているフォームを取得します
      operationId: FormService/export
      parameters:
        - in: query
          name: name
          schema:
            title: アプリ名
            type: string
        - in: query
          name: page
          schema:
            title: ページ番号
            type: integer
        - in: query
          name: limit
          schema:
            title: 1ページの最大件数
            type: integer
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  forms:
                    title: フォームデータリスト
                    type: array
                    items:
                      $ref: '#/components/schemas/form'
  /api/apps/forms/{appsId}:
    get:
      summary: フォーム詳細取得
      tags:
        - Forms
      description: フォームIDからフォームを取得します
      operationId: FormService/get
      parameters:
        - in: path
          name: appsId
          required: true
          explode: false
          schema:
            title: フォームID
            type: integer
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/form'
  /api/apps/{appsId}/fields:
    get:
      summary: フィールド一覧取得
      tags:
        - Fields
      description: 登録されているフィールドを取得します
      operationId: FieldsService/export
      parameters:
        - in: path
          name: appsId
          required: true
          style: simple
          explode: false
          schema:
            title: フォームID
            type: integer
        - in: query
          name: name
          schema:
            title: フィールド名
            type: string
        - in: query
          name: page
          schema:
            title: ページ番号
            type: integer
        - in: query
          name: limit
          schema:
            title: 1ページの最大件数
            type: integer
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  fields:
                    title: フィールドデータリスト
                    type: array
                    items:
                      $ref: '#/components/schemas/form1'
  /api/apps/{appsId}/fields/{fieldId}:
    get:
      summary: フィールド詳細取得
      tags:
        - Fields
      description: フィールドIDからフィールドを取得します
      operationId: FieldsService/get
      parameters:
        - in: path
          name: appsId
          required: true
          style: simple
          explode: false
          schema:
            title: フォームID
            type: integer
        - in: path
          name: fieldId
          required: true
          style: simple
          explode: false
          schema:
            title: フィールドID
            type: integer
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/form1'
  /api/apps/{appsId}/records:
    get:
      summary: レコード一覧取得
      description: 登録されているレコードを取得します。
      tags:
        - Records
      operationId: RecordsService/export
      parameters:
        - in: path
          name: appsId
          description: アプリID
          required: true
          schema:
            title: アプリID
            type: integer
        - in: query
          name: fields
          description: フィールドコード(フィールド識別名をカンマ区切りで指定)
          schema:
            title: フィールドコード
            type: string
        - in: query
          name: order
          description: ソートフィールド
          schema:
            title: ソートフィールド
            type: string
        - in: query
          name: page
          description: ページ番号
          schema:
            title: ページ番号
            type: integer
            minimum: 1
        - in: query
          name: limit
          description: 1ページの最大件数
          schema:
            title: 1ページの最大件数
            type: integer
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  records:
                    title: レコードリスト
                    type: array
                    items:
                      $ref: '#/components/schemas/records'
    post:
      summary: レコード登録
      tags:
        - Records
      description: レコードを新規登録します。
      operationId: RecordsService/insert
      parameters:
        - in: path
          name: appsId
          description: アプリID
          required: true
          schema:
            title: アプリID
            type: integer
      requestBody:
        content:
          application/json:
            schema:
              title: データ
              type: object
              properties:
                record:
                  title: レコードデータ
                  description: フィールド識別名、値のセット
                  type: object
                  x-field: record
      responses:
        '201':
          $ref: '#/components/responses/201'
  /api/apps/{appsId}/records/{recordId}:
    get:
      summary: レコード情報取得
      description: レコードIDからレコード情報を取得します。
      tags:
        - Records
      operationId: RecordsService/get
      parameters:
        - in: path
          name: appsId
          description: アプリID
          required: true
          schema:
            title: アプリID
            type: integer
        - in: path
          name: recordId
          description: レコードID
          required: true
          schema:
            title: レコードID
            type: integer
      responses:
        '200':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/records'
    put:
      summary: レコード更新
      tags:
        - Records
      description: レコードを更新します。
      operationId: RecordsService/update
      parameters:
        - in: path
          name: appsId
          description: アプリID
          required: true
          schema:
            title: アプリID
            type: integer
        - in: path
          name: recordId
          description: レコードID
          required: true
          schema:
            title: レコードID
            type: integer
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/records'
      responses:
        '204':
          $ref: '#/components/responses/204'
    delete:
      summary: レコード削除
      tags:
        - Records
      description: レコードを削除します。
      operationId: RecordsService/delete
      parameters:
        - in: path
          name: appsId
          required: true
          style: simple
          explode: false
          schema:
            title: アプリID
            type: integer
        - in: path
          name: recordId
          required: true
          style: simple
          explode: false
          schema:
            title: レコードID
            type: integer
      responses:
        '204':
          $ref: '#/components/responses/204'
  /api/apps/{appsId}/records/import:
    post:
      summary: レコードインポート
      description: アプリレコードを一括登録します。
      tags:
        - Records
      operationId: RecordsService/import
      parameters:
        - in: path
          name: appsId
          required: true
          style: simple
          explode: false
          schema:
            title: アプリID
            type: integer
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                records:
                  title: レコードデータ
                  type: array
                  maxItems: 100
                  items:
                    $ref: '#/components/schemas/records'
      responses:
        '204':
          $ref: '#/components/responses/204'
  /api/common/notices/{code}:
    get:
      summary: 通知一覧取得
      description: 個人毎の通知一覧を取得します
      tags:
        - Notices
      operationId: NoticeService/get
      parameters:
        - in: path
          name: code
          required: true
          description: 社員番号
          schema:
            title: 社員番号
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                title: 通知データ
                type: object
                properties:
                  code:
                    title: 社員番号
                    type: string
                  notices:
                    type: array
                    items:
                      type: object
                      properties:
                        appsId:
                          title: アプリID
                          type: string
                          x-field: form_id
                        appsName:
                          title: アプリ名
                          type: string
                          x-field: form_name
                        icon:
                          title: アイコン
                          type: object
                          properties:
                            name:
                              title: ファイル名
                              type: string
                              x-field: file_name
                            src:
                              title: ファイルパス
                              type: string
                              x-field: file_src
                        noticeList:
                          type: array
                          items:
                            type: object
                            properties:
                              id:
                                title: 通知ID
                                type: string
                                x-field: filter_id
                              label:
                                title: ラベル
                                type: string
                                x-field: filter_name
                              count:
                                title: 件数
                                type: integer
                                x-field: count
                              url:
                                title: URL
                                type: string
                                x-field: url
components:
  schemas:
    organizations:
      title: 組織データ
      type: object
      required:
        - code
        - name
        - kana
      properties:
        code:
          title: 組織管理コード
          type: string
          maxLength: 256
          x-field: organization_code
        name:
          title: 組織名
          type: string
          maxLength: 256
          x-field: organization_name
        kana:
          title: 組織名かな
          type: string
          maxLength: 512
          x-field: organization_name_kana
        alias:
          title: 組織別名
          type: string
          maxLength: 256
          x-field: organization_name_alias
        aliasKana:
          title: 組織別名かな
          type: string
          maxLength: 256
          x-field: organization_name_alias_kana
        parentCode:
          title: 上位組織管理コード
          type: string
          maxLength: 256
          x-field: parent_organization_code
        note:
          title: 備考
          type: string
          x-field: note
    positions:
      title: 役職データ
      type: object
      required:
        - code
        - name
        - kana
      properties:
        code:
          title: 役職管理コード
          type: string
          maxLength: 256
          x-field: position_code
        name:
          title: 役職名
          type: string
          maxLength: 128
          x-field: position_name
        kana:
          title: 役職名かな
          type: string
          maxLength: 256
          x-field: position_name_kana
        alias:
          title: 役職別名
          type: string
          maxLength: 128
          x-field: position_name_alias
        aliasKana:
          title: 役職別名かな
          type: string
          maxLength: 256
          x-field: position_name_alias_kana
        note:
          title: 説明
          type: string
          x-field: note
    insertUser:
      title: 登録用ユーザデータ
      type: object
      required:
        - code
        - name
        - kana
        - loginId
        - loginPass
        - organizationCode
      properties:
        code:
          title: ユーザ管理コード
          type: string
          maxLength: 256
          x-field: member_code
        name:
          title: ユーザ名
          type: string
          maxLength: 256
          x-field: member_name
        kana:
          title: ユーザ名かな
          type: string
          maxLength: 512
          x-field: member_name_kana
        loginId:
          title: ログインユーザID
          type: string
          maxLength: 256
          x-field: member_login_user_id
        loginPass:
          title: ログインパスワード
          type: string
          maxLength: 256
          writeOnly: true
          x-field: member_login_password
        expire:
          title: アカウント有効期限
          type: string
          format: date
          default: 9999/12/31
          x-field: login_user_id_expire
        outsideAccess:
          title: 外部接続許可
          default: false
          type: boolean
          x-field: login_outside
        organizationCode:
          title: 優先する組織の管理コード
          type: string
          x-field: organization_code
        organizationKeyMan:
          title: 組織の代表者
          type: boolean
          x-field: member_belong_key_man
          default: false
          readOnly: true
        positionCode:
          title: 役職
          type: string
          x-field: position_code
        subBelong:
          title: その他所属する組織の管理コード
          type: array
          items:
            type: object
            properties:
              organizationCode:
                title: サブ組織の管理コード
                type: string
                x-field: organization_code
              organizationKeyMan:
                title: 組織の代表者の管理コード
                type: boolean
                x-field: member_belong_key_man
                readOnly: true
              positionCode:
                title: サブ役職
                type: string
                x-field: position_code
    allUser:
      title: ユーザデータ
      type: object
      required:
        - code
        - name
        - kana
        - loginId
        - organizationCode
      properties:
        code:
          title: ユーザ管理コード
          type: string
          maxLength: 256
          x-field: member_code
        name:
          title: ユーザ名
          type: string
          maxLength: 256
          x-field: member_name
        kana:
          title: ユーザ名かな
          type: string
          maxLength: 512
          x-field: member_name_kana
        loginId:
          title: ログインユーザID
          type: string
          maxLength: 256
          x-field: member_login_user_id
        loginPass:
          title: ログインパスワード
          type: string
          maxLength: 256
          writeOnly: true
          x-field: member_login_password
        expire:
          title: アカウント有効期限
          type: string
          format: date
          default: 9999/12/31
          x-field: login_user_id_expire
        outsideAccess:
          title: 外部接続許可
          type: boolean
          x-field: login_outside
        organizationCode:
          title: 優先する組織の管理コード
          type: string
          x-field: organization_code
        positionCode:
          title: 役職の管理コード
          type: string
          x-field: position_code
        loginErrorCount:
          title: ログインエラー回数
          type: integer
          x-field: login_error_count
          default: 0
        isRetired:
          title: 退職者かどうか
          type: boolean
          x-field: is_retired
          default: false
          writeOnly: true
        subBelong:
          title: その他所属する組織
          type: array
          items:
            type: object
            properties:
              organizationCode:
                title: サブ組織の管理コード
                type: string
                x-field: organization_code
              positionCode:
                title: サブ役職の管理コード
                type: string
                x-field: position_code
    form:
      title: フォームデータ
      type: object
      properties:
        id:
          title: アプリ書式ID
          type: integer
          x-field: form_id
        name:
          title: アプリ書式名
          type: string
          x-field: name
        prefix:
          title: 識別ID接頭語
          type: string
          x-field: unique_id_prefix
        digits:
          title: 自動連番桁数
          type: integer
          x-field: auto_seq_digits
        startDay:
          title: 利用開始日
          type: string
          format: date
          x-field: start_date
        endDay:
          title: 利用終了日
          type: string
          format: date
          x-field: end_date
        readablePeriod:
          title: 参照可能月数
          type: integer
          x-field: readable_period
        explanation:
          title: 説明文
          type: string
          x-field: explanation
        note:
          title: 備考
          type: string
          x-field: note
        size:
          title: 作成データサイズ
          type: integer
          x-field: records_size
        count:
          title: 作成データ件数
          type: integer
          x-field: records_count
        creatorCode:
          title: 登録者管理コード
          type: string
          x-field: creatorCode
        createdAt:
          title: 登録日時
          type: string
          format: date
          x-field: ins_timestamp
        updaterCode:
          title: 更新者管理コード
          type: string
          x-field: updaterCode
        updatedAt:
          title: 更新日時
          type: string
          format: date
          x-field: upd_timestamp
    form1:
      title: フィールドデータ
      type: object
      properties:
        appsId:
          title: 書式ID
          type: integer
          x-field: form_id
        fieldId:
          title: 項目ID
          type: integer
          x-field: field_id
        parentFieldId:
          title: 通常項目
          default: -1
          type: integer
          x-field: parent_field_id
        fieldType:
          title: 項目タイプ名
          type: string
          x-field: field_type
        caption:
          title: 項目見出し
          type: string
          x-field: caption
        explanation:
          title: 項目説明文
          type: string
          x-field: explanation
        uniqueId:
          title: フィールド識別名
          type: string
          x-field: field_unique_id
        note:
          title: 項目備考
          type: string
          x-field: note
        required:
          title: 必須タイプ
          type: boolean
          x-field: required_type
        requiredId:
          title: 比較項目ID
          type: integer
          x-field: required_field_id
        requiredCompare:
          title: 比較
          type: integer
          x-field: required_compare_type
        requiredValue:
          title: 比較値
          type: string
          x-field: required_value
        min_length:
          title: 最小文字数
          type: integer
          x-field: min_length
        max_length:
          title: 最大文字数
          type: integer
          x-field: max_length
        max:
          title: 最大値
          type: integer
          x-field: max
        min:
          title: 最小値
          type: integer
          x-field: min
        digit:
          title: 小数桁
          type: integer
          x-field: decimal_digit
        calc:
          title: 計算式
          type: string
          x-field: calc
        calcFieldId:
          title: 計算に使用するID
          type: integer
          x-field: calc_field_id
        prefix:
          title: 接頭辞
          type: string
          x-field: prefix
        suffix:
          title: 接尾辞
          type: string
          x-field: suffix
        autolink:
          title: 自動連番書式
          type: string
          x-field: use_autolink
        autoFormat:
          title: 自動連番項目の書式
          type: string
          x-field: auto_number_format
        selectItems:
          title: 選択肢
          type: array
          x-field: items
          items:
            type: object
            properties:
              id:
                title: 選択肢ID
                type: integer
                x-field: select_id
              selectName:
                title: 選択肢名
                type: string
                x-field: select_name
              code1:
                title: 関連コード1
                type: string
                x-field: code1
              code2:
                title: 関連コード2
                type: string
                x-field: code2
              code3:
                title: 関連コード3
                type: string
                x-field: code3
              code4:
                title: 関連コード4
                type: string
                x-field: code4
              code5:
                title: 関連コード5
                type: string
                x-field: code5
              calc:
                title: 計算
                type: string
                x-field: calc
              regulationValue:
                title: 既定値
                type: boolean
                x-field: is_selected
        multiple:
          title: 複数選択可能
          type: boolean
          x-field: multiple
        default:
          title: 初期値
          type: string
          x-field: default_value
        relationId:
          title: 連携項目ID
          type: integer
          x-field: relation_id
        relationFieldId:
          title: 連携データベース項目ID
          type: integer
          x-field: relation_field_id
        relationType:
          title: 連携タイプ
          type: string
          x-field: relation_field_type
        subTable:
          title: 明細項目
          type: array
          x-field: sub_table
          items:
            type: object
            properties:
              fieldId:
                title: 項目ID
                type: integer
                x-field: field_id
              fieldType:
                title: 項目タイプ名
                type: string
                x-field: field_type
              caption:
                title: 項目見出し
                type: string
                x-field: caption
              uniqueId:
                title: フィールド識別名
                type: string
                x-field: field_unique_id
              required:
                title: 必須タイプ
                type: boolean
                x-field: required_type
              requiredId:
                title: 比較項目ID
                type: integer
                x-field: required_field_id
              requiredCompare:
                title: 比較
                type: integer
                x-field: required_compare_type
              requiredValue:
                title: 比較値
                type: string
                x-field: required_value
              min_length:
                title: 最小文字数
                type: integer
                x-field: min_length
              max_length:
                title: 最大文字数
                type: integer
                x-field: max_length
              max:
                title: 最大値
                type: integer
                x-field: max
              min:
                title: 最小値
                type: integer
                x-field: min
              digit:
                title: 小数桁
                type: integer
                x-field: decimal_digit
              calc:
                title: 計算式
                type: string
                x-field: calc
              calcFieldId:
                title: 計算に使用するID
                type: integer
                x-field: calc_field_id
              prefix:
                title: 接頭辞
                type: string
                x-field: prefix
              suffix:
                title: 接尾辞
                type: string
                x-field: suffix
              selectItems:
                title: 選択肢
                type: array
                x-field: items
                items:
                  type: object
                  properties:
                    id:
                      title: 選択肢ID
                      type: integer
                      x-field: select_id
                    selectName:
                      title: 選択肢名
                      type: string
                      x-field: select_name
                    code1:
                      title: 関連コード1
                      type: string
                      x-field: code1
                    code2:
                      title: 関連コード2
                      type: string
                      x-field: code2
                    code3:
                      title: 関連コード3
                      type: string
                      x-field: code3
                    code4:
                      title: 関連コード4
                      type: string
                      x-field: code4
                    code5:
                      title: 関連コード5
                      type: string
                      x-field: code5
                    calc:
                      title: 計算
                      type: string
                      x-field: calc
                    regulationValue:
                      title: 既定値
                      type: boolean
                      x-field: is_selected
              multiple:
                title: 複数選択可能
                type: boolean
                x-field: multiple
              default:
                title: 初期値
                type: string
                x-field: default_value
              relationId:
                title: 連携項目ID
                type: integer
                x-field: relation_id
              relationFieldId:
                title: 連携データベース項目ID
                type: integer
                x-field: relation_field_id
              relationType:
                title: 連携タイプ
                type: string
                x-field: relation_field_type
              usage:
                title: 項目管理
                type: integer
                x-field: usage_type
              requiredFieldType:
                title: 条件必須項目タイプ
                type: string
                x-field: required_field_type
        primaryKey:
          title: キー項目
          type: boolean
          x-field: is_primary_key
        usage:
          title: 項目管理
          type: integer
          x-field: usage_type
        requiredFieldType:
          title: 条件必須項目タイプ
          type: string
          x-field: required_field_type
    records:
      title: レコードデータ
      type: object
      required:
        - record
      properties:
        appsId:
          title: フォームID
          type: integer
          minimum: 1
          x-field: form_id
        recordId:
          title: レコードID
          type: integer
          minimum: 1
          x-field: record_id
        uniqueId:
          title: 識別ID
          type: string
          x-field: unique_id
        creatorCode:
          title: 登録者管理コード
          type: string
          x-field: creator_code
        creator:
          title: 登録者名
          type: string
          x-field: creator
        createdAt:
          title: 登録日時
          type: string
          x-field: created-at
        updaterCode:
          title: 更新者管理コード
          type: string
          x-field: updater_code
        updater:
          title: 更新者名
          type: string
          x-field: updater
        updatedAt:
          title: 更新日時
          type: string
          x-field: updated-at
        accessUrl:
          title: アクセスURL
          type: string
          x-field: access_url
        accessEditUrl:
          title: アクセス(編集)URL
          type: string
          x-field: access_edit_url
        isDeleted:
          title: 削除タイプ
          type: integer
          x-field: is_deleted
          minimum: -1
          maximum: 1
        record:
          title: レコードデータ
          type: object
          x-field: record
  responses:
    '200':
      description: OK
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/records'
    '201':
      description: Created
    '204':
      description: No Content
  parameters:
    page:
      in: query
      name: page
      description: ページ番号
      schema:
        title: ページ番号
        type: integer
    limit:
      in: query
      name: limit
      description: 1ページの最大件数
      schema:
        title: 1ページの最大件数
        type: integer
x-tagGroups:
  - name: アプリAPI
    tags:
      - Forms
      - Fields
      - Records
  - name: ユーザAPI
    tags:
      - Organizations
      - Positions
      - Users
  - name: 通知API
    tags:
      - Notices